SetByteValue(DicomElement,byte[],int) Method

Summary

Sets the character value(s) of a Data Element.

Syntax

C++

public bool SetByteValue( 
   DicomElement element, 
   byte[] value, 
   int count 
)

Public Overloads Function SetByteValue( _ 
   ByVal element As DicomElement, _ 
   ByVal value() As Byte, _ 
   ByVal count As Integer _ 
) As Boolean

public: 
bool SetByteValue(  
   DicomElement^ element, 
   array<byte>^ value, 
   int count 
)

Parameters

element
An item in the Data Set.

value
Pointer to a buffer that contains the character value(s) to set. If you want to set multiple values in the Value Field, put all character values in this string and set count to the appropriate number of values.

count
Value that indicates the number of values to set in the Value Field. If you want to set multiple values in the Value Field, put all the character values in value and set count to the appropriate number.

Return Value

true if the character values were set successfully; otherwise, it is false (it could not set the character values of the Data Element).

Remarks

If you want to set more than one value in the Value Field of the Data Element, put all the character values in value and set count to the corresponding number of entries. For example, if you wish to set three character values in the Value Field of the Data Element, put all three characters in value and set count to three. If more than one value is stored in the Value Field of the Data Element, you must set all values at the same time.

A character has a standard size of one byte. When multiple characters are in value, the first byte of data is the first character, the second byte of data is the second character, etc.

This method can be called only if the Value Representation of the Data Element is:

For more information about Value Representations, refer to Default Value Representation Table.

Example

For an example, refer to SetIntValue.

Requirements

Target Platforms